Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

repo-wide: Unify spelling/format of ".eopkg file(s)" #550

Merged
merged 1 commit into from
Jul 10, 2024

Conversation

Staudey
Copy link
Member

@Staudey Staudey commented Jun 9, 2024

Description

This unifies how .eopkg files are called throughout the docs. Previously there were all sorts of formats: *eopkg, eopkg, .eopkg, *.eopkg

I've decided on .eopkg because my other preference *.eopkg was tautological in some cases where the wildcard was confusing. eopkg is easily confused with the application itself and *eopkg seem like a worse version of *.eopkg

Also format some mentions of the eopkg program correctly inside back-ticks, slightly correct the referenced name of a eopkg config file section, and some other minor spelling/formatting/grammar fixes found while searching the docs for places where .eopkg files are mentioned

@davidjharder
Copy link
Member

This is great. Can you add a sentence about this to the style guide page too

@Staudey
Copy link
Member Author

Staudey commented Jun 9, 2024

I've added an eopkg-specific section to the Style Guide. Not sure if we want to unify this for all files. I just saw some other file talk in e.g. the package.yml page, which includes the * wildcard (for example *.py), but in those isolated cases it wasn't confusing, unlike when I replaced all .eopkg references with *.eopkg

@ermo
Copy link
Contributor

ermo commented Jun 22, 2024

I like this.

Plus some other minor formatting/spelling/grammar issues

Signed-off-by: Thomas Staudinger <[email protected]>
Copy link
Member

@EbonJaeger EbonJaeger left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

@EbonJaeger EbonJaeger merged commit 0eed72a into getsolus:master Jul 10, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants